Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@rimbu/common
Advanced tools
This package exports common types and objects used in many other Rimbu packages.
Here is a brief overview:
Name | Description |
---|---|
CollectFun | types and values used in various collect methods in the collection. |
Comp | an interface and default implementations of comparison functions to order/sort values. |
Eq | an interface and default implementations of equality functions to check value equality |
Err | functions to easily create error throwing behavior as fallback values |
FastIterable | an Iterable implementation that can be more performant than usual iterables |
IndexRange | utilities to select index ranges in indexed collections |
OptLazy | a utility to provide values that can optionally be lazy |
Range | utility types to specify ranges for comparable types |
Reducer | an API to create reusable pieces of logic that process streams of data that can be processed in parallel |
TraverseState | a utility for loops to maintain the traversal state |
Update | a standard way to update a value |
Other than these values, there are a number of utility types that are exported that are also used throughout the collection.
For complete documentation please visit the Rimbu Docs.
Or Try Out Rimbu in CodeSandBox.
All types are exported through @rimbu/core
. It is recommended to use that package.
To install this package separately:
yarn add @rimbu/common
or
npm i @rimbu/common
Create a file called rimbu.ts
and add the following:
export * from 'https://deno.land/x/rimbu/common/mod.ts';
Or using a pinned version (x.y.z
):
export * from 'https://deno.land/x/rimbu/common@x.y.z/mod.ts';
Then import what you need from rimbu.ts
:
import { Eq } from './rimbu.ts';
Because Rimbu uses complex types, it's recommended to use the --no-check
flag (your editor should already have checked your code) and to specify a tsconfig.json
file with the settings described below.
Running your script then becomes:
deno run --no-check --config tsconfig.json <your-script>.ts
tsconfig.json
settingsRimbu uses advanced and recursive typing, potentially making the TypeScript compiler quite slow in some cases, or causing infinite recursion. It is recommended to set the following values in the tsconfig.json
file of your project:
{
"compilerOptions": {
"skipLibCheck": true,
"noStrictGenericChecks": true
}
}
import { Eq } from '@rimbu/common';
console.log(Eq.stringCaseInsentitive()('abc', 'AbC'));
// => true
Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.
Made with contributors-img.
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
See LICENSE for more information.
FAQs
Common types and objects used in many other Rimbu packages
The npm package @rimbu/common receives a total of 2,566 weekly downloads. As such, @rimbu/common popularity was classified as popular.
We found that @rimbu/common demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.